/**
 * Copyright (c) 2009 Cycle Information Technology
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this 
 * software and associated documentation files (the "Software"), to deal in the Software 
 * without restriction, including without limitation the rights to use, copy, modify, 
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to 
 * permit persons to whom the Software is furnished to do so, subject to the following 
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies 
 * or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */
package com.cycleit.cycleframework.event {
	
	/**
	 * Evento usado para indicar los cambios de estado en la vista.
	 */ 
	public class ViewStateChangeEvent extends CycleEvent{
		
		/**
		 *  La constante <code>ViewStateChangeEvent.MODIFY_VIEW</code> define el valor de la propiedad
		 *  <code>type</code> del objeto evento para un evento <code>modifyView</code>.
		 *
		 *  <p>Las propiedades del objeto evento tienen los siguientes valores:</p>
		 *  <table class="innertable">
		 *     <tr><th>Propiedad</th><th>valor</th></tr>
		 *     <tr><td><code>state</code></td><td>La lista de nodos en el árbol de navegación hacia donde queremos navegar.</td></tr>
		 *     <tr><td><code>index</code></td><td>Índice a partir del cual queremos navegar dentro del árbol de navegación en función del estado actual.</td></tr>
		 *     <tr><td><code>bubbles</code></td><td>false</td></tr>
		 *     <tr><td><code>cancelable</code></td><td>false</td></tr>
		 *     <tr><td><code>currentTarget</code></td><td>El objeto que define el listener que maneja el evento.</td></tr>
		 *     <tr><td><code>target</code></td><td>El objeto que despachó el evento;
		 *       no es siempre el Objeto que escucha el evento.
		 *       Para ello utilizar <code>currentTarget</code> property.</td></tr>
		 *  </table>
		 *
		 *  @eventType navigationFinish
		 */
		public static const MODIFY_VIEW:String = "modifyView";
		
		/**
		 * La lista de nodos en el árbol de navegación hacia donde queremos navegar.
		 */ 
		public var state:Array;
		/**
		 * Índice a partir del cual queremos navegar dentro del árbol de navegación en función del estado actual.
		 */ 
		public var index:Number;
		
		/**
		 * Constructor
		 *  
		 * @param type Constante identificadora del evento.
		 * @param state ArrayCollection que contiene la lista de identificadores que definen
		 *               el estado al que se quiere navegar.
		 * @param index Índice desde el que se tiene que concatenar state al estado anterior.
		 * 
		 */		
		public function ViewStateChangeEvent(type:String,state:Array,index:Number=0) {
			super(type);
			this.state = state;
			this.index = index;
		}

	}
}